Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add script to automatically publish readme to docker hub #6118

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

inosmeet
Copy link
Contributor

Which problem is this PR solving?

Fixes: #3842

Description of the changes

  • Added a shell script that publishes README.md files along with docker images to docker hub

How was this change tested?

  • Locally as well as on fork

Checklist

Signed-off-by: Meet Soni <meetsoni3017@gmail.com>
@inosmeet inosmeet requested a review from a team as a code owner October 24, 2024 16:01
@dosubot dosubot bot added the docker Pull requests that update Docker code label Oct 24, 2024
Signed-off-by: Meet Soni <meetsoni3017@gmail.com>
Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.41%. Comparing base (f9474f9) to head (d6b47b3).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6118      +/-   ##
==========================================
- Coverage   96.48%   96.41%   -0.07%     
==========================================
  Files         352      352              
  Lines       19973    20007      +34     
==========================================
+ Hits        19270    19289      +19     
- Misses        520      533      +13     
- Partials      183      185       +2     
Flag Coverage Δ
badger_v1 8.42% <ø> (ø)
badger_v2 1.70% <ø> (ø)
cassandra-4.x-v1 14.57% <ø> (ø)
cassandra-4.x-v2 1.64% <ø> (ø)
cassandra-5.x-v1 14.57% <ø> (ø)
cassandra-5.x-v2 1.64% <ø> (ø)
elasticsearch-6.x-v1 18.73% <ø> (+0.01%) ⬆️
elasticsearch-7.x-v1 18.81% <ø> (+0.01%) ⬆️
elasticsearch-8.x-v1 18.98% <ø> (ø)
elasticsearch-8.x-v2 1.70% <ø> (ø)
grpc_v1 8.78% <ø> (ø)
grpc_v2 6.72% <ø> (ø)
kafka-v1 8.99% <ø> (ø)
kafka-v2 1.70% <ø> (ø)
memory_v2 1.69% <ø> (-0.02%) ⬇️
opensearch-1.x-v1 18.85% <ø> (ø)
opensearch-2.x-v1 18.85% <ø> (-0.02%) ⬇️
opensearch-2.x-v2 ?
tailsampling-processor 0.48% <ø> (ø)
unittests 95.33% <ø> (-0.07%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Meet Soni <meetsoni3017@gmail.com>
@inosmeet
Copy link
Contributor Author

Screenshot from 2024-10-24 21-20-58

scripts/build-upload-a-docker-image.sh Outdated Show resolved Hide resolved
scripts/upload-docker-readme.sh Outdated Show resolved Hide resolved
scripts/upload-docker-readme.sh Outdated Show resolved Hide resolved
scripts/upload-docker-readme.sh Show resolved Hide resolved
scripts/upload-docker-readme.sh Show resolved Hide resolved
scripts/upload-docker-readme.sh Show resolved Hide resolved
scripts/upload-docker-readme.sh Outdated Show resolved Hide resolved
scripts/upload-docker-readme.sh Outdated Show resolved Hide resolved
scripts/upload-docker-readme.sh Outdated Show resolved Hide resolved
Signed-off-by: Meet Soni <meetsoni3017@gmail.com>
Signed-off-by: Meet Soni <meetsoni3017@gmail.com>
Signed-off-by: Meet Soni <meetsoni3017@gmail.com>
@inosmeet
Copy link
Contributor Author

As for the quay.io - I wanted to get satisfactory result with the docker to get started with this PR, I'll look into it now.

Unrelated to this PR -
These recurring lint failures makes me wonder if we should have a pre-commit configured for the repo?
what do you think? @yurishkuro

Signed-off-by: Meet Soni <meetsoni3017@gmail.com>
@inosmeet
Copy link
Contributor Author

for quay.io:
Screenshot from 2024-10-25 14-29-09

scripts/build-upload-a-docker-image.sh Outdated Show resolved Hide resolved
@@ -127,6 +129,10 @@ docker buildx build --output "${PUSHTAG}" ${target_arg} ${base_debug_img_arg} \
echo "::endgroup::"
echo "Finished building${upload_comment} ${component_name} =============="

if [[ "$upload_success" == "Y" ]]; then
bash scripts/upload-docker-readme.sh "${component_name}" "${dir_arg}"/README.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: enclose in echo group as below, to collapse the logs

Signed-off-by: Meet Soni <meetsoni3017@gmail.com>
@inosmeet
Copy link
Contributor Author

CIT OpenSearch / opoensearch 2.x v2 passes on a retry

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docker Pull requests that update Docker code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: Publish description and readme to Docker Hub
2 participants